Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/#080 panda css 라이브러리 설정 #91

Merged
merged 29 commits into from
Nov 11, 2024

Conversation

pipisebastian
Copy link
Member

📝 변경 사항

  • panda css 라이브러리 추가
  • panda css 플러그인 추가
    • eslint -> 축약형 금지 및 추천 규칙 적용
    • prettier - css 순서 자동 정렬)
  • import 문 자동 정렬
  • panda css 토큰, 레시피 등 초기 설정
  • 컴포넌트 UI 구현

🔍 변경 사항 설명

디자인 시스템 구축

  • 디자이너님께서 맞춰주신 디자인을 최대한 따라가려 했습니다
  • token -> shadow, raddi, spacing, color 존재
  • typography -> 마크다운 편집기 제외한 부분에 대해 타이포그래피(마크다운까지 들어가면 오히려 코드복잡성이 증가할 것 같았습니다)
  • recipe -> 글래스모피즘 기반 레시피 추가 -> 추후에 글래스모피즘이 들어가는 컴포넌트는 해당 레시피만 추가하면 됩니다.
  • 각 컴포넌트마다 들어가는 디자인적인 요소는, 종이로만 정리했습니다. 추후에 컴퓨터로 다시 정리해서 올려놓겠습니다!
  • 또한 디자인을 100% 따라가지는 못했습니다. 아이콘의 radii는 디자인상에서 14px이 있었지만, 개발의 편의를 위해 없앴으며,
  • border 색상의 경우 linear gradient하게 색상이 들어가는데 이 부분은 panda css로 구현하지 못했습니다. 더 찾아보겠습니다!

image
image

import문 자동 정렬

  • 프론트만 되고 있습니다.. 모노레포에서 둘다 적용하는데 실패했습니다......

panda css eslint + order 정렬 플러그인

  • 저번에 말씀드린 대로 panda css 규칙을 추가했고, 단축속성을 금지시켜 bg와 같은 단축속성을 적을 경우 에러를 띄워주도록 했습니다.
  • 그런데 토큰이나 레시피의 경우, eslint 규칙 중 panda.config.ts에 설정값을 다 넣어줘야한다는 규칙이 있습니다 (참고링크)
  • 그런데 토큰이 많아지면서 하나의 파일에 넣기에는 가독성이 떨어져 해당 규칙을 꺼버리고 파일을 분리했습니다.
  • 또한, css 속성이 많아질수록 순서를 지키기 어려웠고, 자동 저장으로 order 순서를 정렬해주는 플러그인을 찾아 적용했습니다 (참고링크)

css 네이밍

  • css 네이밍은 container, content, box등을 접두사로 붙혔는데 괜찮은지 확인 부탁드립니다!

폴더구조

  • featurer 기반에서, 무엇을 feature로 둬야할지 고민했습니다.
  • workspace, editor, page 로 나눴는데, 괜찮은지 확인 부탁드립니다!

🙏 질문 사항

  • 문서화는 다 하지 못했습니다.. 이건 오늘(월요일)안에 해보겠습니다! (정리중인 링크)
  • 다음부터 컴포넌트 구현은 브랜치 따로 파겠습니다... 급해서 다 넣어버렸습니다.. 🙇‍♂️
  • 폴더구조, 파일 네이밍, 변수/함수 네이밍 등등,, 전체적인 컨벤션이 괜찮은지 확인 부탁드립니다! (예상 리뷰시간 45분)

📷 스크린샷 (선택)

image

✅ 작성자 체크리스트

  • Self-review: 코드가 스스로 검토됨
  • Unit tests 추가 또는 수정
  • 로컬에서 모든 기능이 정상 작동함
  • 린터 및 포맷터로 코드 정리됨
  • 의존성 업데이트 확인
  • 문서 업데이트 또는 주석 추가 (필요 시)

…into Feature/#080_panda_css_라이브러리_설정

# Conflicts:
#	pnpm-lock.yaml
- 토큰, 레시피의 경우 다른 파일에서 관리하는게 편하기에 rule 제거
- 단축 속성 사용못하도록 rule 추가

#80
- 색상, 둥글기, 그림자, 간격 토큰 추가

#80
- icon의 경우, 특정 사이즈 (24px, 30px)만을 사용하기에 레시피로 분리해 재활용

#80
- 오히려 구현복잡도가 증가해져서 제거

#80
@pipisebastian pipisebastian added FE 프론트엔드 작업 Feat 새로운 기능 추가나 기존 기능 확장 작업 P1 긴급/즉시 반영 labels Nov 10, 2024
@pipisebastian pipisebastian self-assigned this Nov 10, 2024
@Ludovico7
Copy link
Collaborator

고생하셨습니다! 네이밍도 깔끔하게 구조별로 잘 지어진것 같습니다! 하나 질문이 있는데
현재 MenuButton과 Sidebar에만 Wrapper라는 css변수가 있는데, Container나 Box와 어떤 차이가 있는 건가요?

Copy link
Collaborator

@minjungw00 minjungw00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍👍👍👍👍

@hyonun321
Copy link
Collaborator

conflict 발생했네요 eslint.config.js 부분인듯합니다. 제가 한번 테스트 해볼께요

@hyonun321
Copy link
Collaborator

    settings: {
      "import/resolver": {
        typescript: {
          alwaysTryTypes: true,
          project: resolve(__dirname, "./tsconfig.json"),
        },
      },
    },

하고

    settings: {
      "import/resolver": {
        typescript: {
          alwaysTryTypes: true,
          project: "./tsconfig.json",
        },
        node: {
          extensions: [".js", ".jsx", ".ts", ".tsx"],
        },
      },
      "import/parsers": {
        "@typescript-eslint/parser": [".ts", ".tsx"],
      },
      "import/internal-regex": "^@/",
    },

두개를 합쳐서

settings: {
      "import/resolver": {
        typescript: {
          alwaysTryTypes: true,
          project: resolve(__dirname, "./tsconfig.json"), // 여기 바뀜
        },
        react: {  // react문 여기추가
          version: "detect",
        },
        node: {
          extensions: [".js", ".jsx", ".ts", ".tsx"],
        },
      },
      "import/parsers": {
        "@typescript-eslint/parser": [".ts", ".tsx"],
      },
      "import/internal-regex": "^@/",
    },

위처럼 작성해보았습니다. 확인해보니 에러안나고 저장할때 잘되는데 저렇게 conflict resolve 할까요?
확인부탁드립니다!

@pipisebastian
Copy link
Member Author

고생하셨습니다! 네이밍도 깔끔하게 구조별로 잘 지어진것 같습니다! 하나 질문이 있는데 현재 MenuButton과 Sidebar에만 Wrapper라는 css변수가 있는데, Container나 Box와 어떤 차이가 있는 건가요?

container는 하나의 요소를 담도록, wrapper 여러개 요소의 담도록 해주었습니다! Box는 Container, Wrapper도 아닐때, icon이나 text의 스타일이 필요할때 사용해줬습니다.
그런데 코드를 보니 container와 wrapper가 바뀐것도 보이는 것 같군요,,ㅎㅎ 개발하실때 적절하게 수정해주시면 좋을 것 같습니당~!

@pipisebastian
Copy link
Member Author

위처럼 작성해보았습니다. 확인해보니 에러안나고 저장할때 잘되는데 저렇게 conflict resolve 할까요? 확인부탁드립니다!

감사합니다! 그런데 프로젝트 경로의 경우, project: "./tsconfig.json", 요걸로 해야할 것 같아요!
보내주신걸로 해보니, ctrl s할때랑 pnpm lint했을때랑 import 순서가 다르게 저장이 되더라구요..

Copy link
Collaborator

@hyonun321 hyonun321 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

수고하셨습니다!

@hyonun321
Copy link
Collaborator

hyonun321 commented Nov 11, 2024

오우 그런 차이가있엇군요! pnpm lint 와 ctrl+s 가 다르단것도 유의해야겠어요 !

@pipisebastian
Copy link
Member Author

pipisebastian commented Nov 11, 2024

오우 그런 차이가있엇군요! pnpm lint 와 ctrl+s 가 다르단것도 유의해야겠어요 !

아 이제는 둘다 같게 수정했습니다!!

@minjungw00 minjungw00 merged commit 05e6b0b into dev Nov 11, 2024
1 of 2 checks passed
@pipisebastian pipisebastian deleted the Feature/#080_panda_css_라이브러리_설정 branch November 15, 2024 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FE 프론트엔드 작업 Feat 새로운 기능 추가나 기존 기능 확장 작업 P1 긴급/즉시 반영
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants